Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.asymptotelabs.ai/llms.txt

Use this file to discover all available pages before exploring further.

Command Reference

Use this reference to browse Beacon commands by hierarchy. Each command links to the consolidated guide section with examples, flags, and operational notes.

beacon

beacon [command]
Top-level Beacon CLI commands.
CommandDescription
beacon versionDisplay the installed Beacon CLI version.
beacon endpointManage local endpoint telemetry, runtime logs, and integrations.

beacon endpoint

beacon endpoint [command]
Manage the local endpoint agent and inspect supported AI runtime telemetry.
CommandDescription
beacon endpoint installInstall or update the local endpoint collector, runtime telemetry configuration, retention settings, and optional forwarding.
beacon endpoint statusInspect collector health, runtime log state, configured harnesses, diagnostics, and forwarding readiness.
beacon endpoint discoverDiscover supported local AI agent runtimes and their telemetry configuration state.
beacon endpoint repairRepair Beacon endpoint service files and telemetry configuration.
beacon endpoint uninstallRemove Beacon endpoint service files, with an option to keep local logs.
beacon endpoint dashboardRun the local dashboard over Beacon runtime logs for endpoint inspection.
beacon endpoint wazuhConfigure Wazuh ingestion for Beacon endpoint events.
beacon endpoint elasticGenerate Elastic content and run a local Elasticsearch, Kibana, and Filebeat validation stack.
beacon endpoint hooksManage Cursor, Factory, and OpenCode hook-based endpoint telemetry.
beacon endpoint integrations claude-coworkSet up and validate Claude Cowork OTLP export.

beacon endpoint wazuh

beacon endpoint wazuh [command]
Generate Wazuh configuration, content packs, and validation events for Beacon endpoint logs.
CommandDescription
beacon endpoint wazuh print-configPrint a Wazuh localfile snippet for Beacon endpoint events.
beacon endpoint wazuh install-packGenerate Beacon Wazuh rules, sample events, and config snippets into a directory.
beacon endpoint wazuh validateWrite and describe a known-good Beacon Wazuh validation event.

beacon endpoint elastic

beacon endpoint elastic [command]
Generate Elastic configuration, content packs, and local validation stacks for Beacon endpoint logs.
CommandDescription
beacon endpoint elastic print-configPrint a Filebeat config for Beacon endpoint events.
beacon endpoint elastic install-packGenerate Elasticsearch, Kibana, Filebeat, and Elastic Agent content into a directory.
beacon endpoint elastic upStart a local Elasticsearch, Kibana, and Filebeat validation stack.
beacon endpoint elastic downStop the local Elastic validation stack.

beacon endpoint hooks

beacon endpoint hooks [command]
Install, inspect, and remove hook-based telemetry for supported local runtimes.
CommandDescription
beacon endpoint hooks installInstall Beacon endpoint hooks for supported harnesses such as Cursor, Factory, and OpenCode.
beacon endpoint hooks statusShow Beacon endpoint hook integration status for a supported harness.
beacon endpoint hooks uninstallRemove Beacon endpoint hooks for supported harnesses.

beacon endpoint integrations claude-cowork

beacon endpoint integrations claude-cowork [command]
Configure and validate Claude Cowork OpenTelemetry export.
CommandDescription
beacon endpoint integrations claude-cowork print-configPrint Claude Cowork OTLP setup guidance for organization administrators.
beacon endpoint integrations claude-cowork setupPrint or create Claude Cowork OTLP admin settings.
beacon endpoint integrations claude-cowork statusShow Claude Cowork endpoint integration status.
beacon endpoint integrations claude-cowork validateValidate whether Claude Cowork events are arriving at the configured collector.